home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / programming / libraries / eagui11.lha / EAGUI / Readme.doc < prev    next >
Encoding:
Text File  |  1993-12-22  |  7.2 KB  |  165 lines
  1.  
  2. -----------------------------------------------------------------------------
  3.  
  4.                  Environment Adaptive Graphic User Interface
  5.  
  6. -----------------------------------------------------------------------------
  7. $RCSfile: Readme.doc,v $
  8. $Revision: 1.4 $
  9. $Date: 1993/12/13 22:33:58 $
  10. -----------------------------------------------------------------------------
  11.  
  12.      Copyright
  13.      ¯¯¯¯¯¯¯¯¯
  14. EAGUI is Copyright © 1993 by Marcel Offermans and Frank Groen, and may not be
  15. disassembled or reverse-engineered in any way. You may use this software at
  16. your own risk. We cannot be held responsible for any damage it might do. You
  17. may copy the original archive, but you're not allowed to rename it or change
  18. its contents (to avoid confusion). Also, you may not charge anything for it,
  19. other than the costs of the media it is on.
  20.  
  21.  
  22.      Requirements
  23.      ¯¯¯¯¯¯¯¯¯¯¯¯
  24. EAGUI needs at least Release 2, because it makes use of a lot of its
  25. features.
  26.  
  27.  
  28.      Archive Contents and Installation
  29.      ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  30. The archive should contain the following files. We've carefully chosen them,
  31. so that the archive doesn't grow needlessly big. You should be able to build
  32. everything from these files. Reading these descriptions should be enough to
  33. be able to install the package.
  34.      "EAGUI.library" - Should go in your LIBS: directory, or any other
  35. directory from which it can be loaded.
  36.      "EAGUI.h" - Header file that you need to include in your sources. If you
  37. use any other language than C, you need to rewrite this file.
  38.      "EAGUI_macros.h" - Header file containing macros, which make life
  39. easier. These too are written for C, so if you use another language, you
  40. might want to rewrite these too.
  41.      "EAGUI_protos.h" - Prototypes for the library functions. They're
  42. included by "EAGUI.h", so you don't need to include this file yourself.
  43.      "EAGUI_lib.c" - Stubs for varargs function calls. You must compile these
  44. and link them to your source. The file is tested with the SAS/C compiler, but
  45. may need some modification with others. If you use the SAS/C compiler, you
  46. can also make use of its `#pragma tagcall' option instead.
  47.      "EAGUI.fd" - Standard FD file, which can be used to generate pragmas for
  48. SAS/C. Lots of other languages need such a file too.
  49.      "EAGUI.doc" - Standard autodoc file, containing all public functions in
  50. the library. You can use this file to create an AmigaGuide version, if you
  51. like that better.
  52.      "ReadMe.doc" - This file, containing the Copyright notice, the Archive
  53. Contents and other information.
  54.      "Tutorial.doc" - A tutorial, which explains how to use the library in
  55. your own applications.
  56.      "Tutorial_1.pic" - A picture of some important layout parameters of
  57. objects, as explained in the tutorial.
  58.      "example.c" - A simple example source. This is the example that is
  59. mentioned in the tutorial.
  60.      "example" - The executable of the example, for those of you who want to
  61. see EAGUI in action right away. The executable takes two optional command
  62. line parameters: a fontname (including the .font suffix) and a font y-size.
  63.  
  64.      Using EAGUI
  65.      ¯¯¯¯¯¯¯¯¯¯¯
  66. If you're an application programmer, and you want to use EAGUI, please keep
  67. the following in mind. Depending on the type of software you write, the
  68. conditions under which you may use EAGUI differ. Basically, if you don't make
  69. any money out of your program, we don't expect you to pay us in any way.
  70.      If you use it in any Public Domain or FreeWare software, you may use
  71. EAGUI for free. The only thing we want you to do, is keep us informed of the
  72. fact that you've used EAGUI.
  73.      If you use it in any ShareWare software, you must first contact us, to
  74. obtain some kind of licence. Usually we'll settle for a free registration, or
  75. something like that.
  76.      If you use it in any Commercial software, you must first contact us. We
  77. will then work out a deal.
  78.  
  79. If you're a application user, you may always use EAGUI for free. This may
  80. sound natural, but some other programmers charge every user for using their
  81. library.
  82.  
  83.  
  84.      Support for Developers
  85.      ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  86. We support everybody that uses EAGUI as well as we can. We'll be happy to
  87. answer any questions you might have. Currently, we're considering adding some
  88. development tools to the system, but a lot will depend on the feedback we
  89. get. After all, if nobody uses EAGUI, there's no point in supporting it.
  90.  
  91. At the moment, we've only used EAGUI to develop applications in C, but there
  92. is no reason why it shouldn't work with any other language. If you use it in
  93. any other language, and you've written header files for that language, we'd
  94. like you to send them to us, so we can distribute them to other developers.
  95.  
  96.  
  97.      The Future
  98.      ¯¯¯¯¯¯¯¯¯¯
  99. Like most developers, we hope that these kinds of tools will some day be
  100. integrated into the operating system. When designing EAGUI, we've tried to
  101. anticipate what Commodore will do in future releases of the AmigaOS. As soon
  102. as Commodore releases a similar system, we encourage you to use that instead,
  103. and will try to make a release of EAGUI that simple interfaces to this
  104. system.
  105.  
  106.  
  107.      The Authors
  108.      ¯¯¯¯¯¯¯¯¯¯¯
  109. We've tried to provide clear, readable documentation. Although it is not our
  110. native language, we've chosen to write everything in english, because that
  111. seems to be the de facto standard for most development documentation. If you
  112. find parts of these documents difficult to understand, or if you discover any
  113. type of mistakes, please report them to us. Also, we're always willing to
  114. answer any questions you might have. If you've found a bug, please state as
  115. clearly as possible how we can reproduce it, or under what circumstances the
  116. bug surfaced, and what your system looks like (computer model, Kickstart
  117. version, Workbench version, any programs running in the background). The more
  118. detailed your bug report is, the better the chance we can fix it quickly.
  119. We're also always looking for ways to enhance the system, so if you have any
  120. suggestions, please mail them to us. Finally, if you don't like EAGUI, please
  121. tell us what you think is wrong with it: we always listen to constructive
  122. criticism.
  123.  
  124. To contact us, write to:
  125.  
  126.      Marcel Offermans
  127.           2:281/614.1@fidonet
  128.           marcel@dutw30.tudelft.nl
  129.  
  130.      Frank Groen
  131.           2:281/614.2@fidonet
  132.  
  133. We understand the following languages:
  134.  
  135.      nederlands
  136.      english
  137.      deutsch
  138.  
  139.  
  140.      Thanks to
  141.      ¯¯¯¯¯¯¯¯¯
  142. Commodore-Amiga Inc. for producing this nice mix of hard- and software which
  143. we've learned to appreciate so much over the years.
  144.  
  145. Everybody that contributes to The Amiga Developers Domain, which is the best
  146. BBS I've seen.
  147.  
  148. Guns N' Roses, Pearl Jam, Rage Against The Machine, Aerosmith, The Cult.
  149.  
  150. The following person:
  151.      Paul van der Valk
  152.  
  153.  
  154.      Release report
  155.      ¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  156. 1.0 - First release.
  157.  
  158. 1.1 - Corrected a lot of small mistakes in the documentation and sources, and
  159. added a full example source (and executable), together with an IFF picture
  160. file, which explains the relation between object border dimensions, offsets
  161. and sizes. Also fixed a bug in ea_LayoutObjects(): Under certain
  162. circumstances, object sizes weren't calculated correctly, and another bug
  163. which caused a lot of Enforcer BYTE read hits. Furthermore, the
  164. "EAGUI_protos.h" file was added. You need it to compile.
  165.